﻿/*
Copyright © 2011 François Karman

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

See <license.txt> for the complete license of the software.
*/

using System;
using System.Collections.Generic;

namespace Simple.Storage
{
    /// <summary>
    /// Represents the key of a persisted instance and its associated index values.
    /// </summary>
    /// <typeparam name="T">
    /// The associated persisted class.
    /// </typeparam>
    public interface IDescriptor<T>
    {
        /// <summary>
        /// Gets the associated persisted class.
        /// </summary>
        Type ClassType { get; }

        /// <summary>
        /// Gets the key of the instance.
        /// </summary>
        object Key { get; }

        /// <summary>
        /// Gets the index values of the instance for each known index.
        /// </summary>
        IDictionary<string, object> Index { get; }

        /// <summary>
        /// Gets the associated persisted instance.
        /// </summary>
        T Value { get; }
    }
}
